Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add snowflake-sqlalchemy in ./docker/requirements-local.txt #25312

Merged
merged 3 commits into from
Sep 18, 2023

Conversation

janhavitripurwar
Copy link
Contributor

If using Docker Compose to run Superset, the snowflake-sqlalchemy library should be added to the./docker/requirements-local.txt file for Superset to recognise the Snowflake database connector.

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

If using Docker Compose to run Superset, the snowflake-sqlalchemy library should be added to the./docker/requirements-local.txt file for Superset to recognise the Snowflake database connector.
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@janhavitripurwar janhavitripurwar changed the title Update snowflake.mdx docs: add snowflake-sqlalchemy in ./docker/requirements-local.txt Sep 15, 2023
@sfirke
Copy link
Member

sfirke commented Sep 15, 2023

Thanks for submitting a PR! I think this is a small improvement, it doesn't hurt, but it is symptomatic of a bigger problem. There is a whole section that describes this process: https://superset.apache.org/docs/databases/docker-add-drivers/ and I'd rather not duplicate that content. It shouldn't need to be in every single database page, ideally.

Most DB pages (for instance MySQL, Snowflake) don't repeat this info. I like how it's documented on the BigQuery page, where it links back to the main docker driver docs.

Could you instead link back to the main add driver page, copying the BigQuery example? I would merge that. Though to me it says something bigger should also be improved if we have to link back to that page from every single DB subpage.

@sfirke sfirke self-assigned this Sep 15, 2023
Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janhavitripurwar
Copy link
Contributor Author

janhavitripurwar commented Sep 16, 2023

Please include a link back to this page: https://superset.apache.org/docs/databases/docker-add-drivers/

See https://superset.apache.org/docs/databases/bigquery for example.

@sfirke, Thank you for responding.
While using Snowflake with Superset, it confused me as adding the python package in./docker/requirements-local.txt was not mentioned here.
I discovered it when I came across this ClickHouse page, and looking through this code part proved it .

I made the necessary changes as suggested by you. Currently, looking at the Snowflake page and connecting is not very intuitive. Linking back to this doc makes it easier for someone new to Superset and Snowflake.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for updating!

@sfirke sfirke merged commit 6e799e3 into apache:master Sep 18, 2023
28 checks passed
eschutho pushed a commit to Superset-Community-Partners/superset that referenced this pull request Sep 21, 2023
cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.1.0 labels Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XS 🚢 3.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants